All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.CompositeView 

java.lang.Object
   |
   +----com.sun.java.swing.text.View
           |
           +----com.sun.java.swing.text.CompositeView
public abstract class CompositeView
extends View
A view of a text model that has a children box. If the box is vertical, it might be useful to represent something like a collection of lines or paragraphs. If the box is horizontal, it might be used to represent unwrapped lines.

Constructor Index

o CompositeView(Element)
Constructs a CompositeView for the given element.

Method Index

o append(View)
Appends a single child view.
o childAllocation(int, Rectangle)
Returns the allocation for a given child.
o getBottomInset()
Gets the bottom inset.
o getChildAllocation(int, Shape)
Fetches the allocation for the given child view.
o getInsideAllocation(Shape)
Translates the allocation given to the view to the allocation used for composing the interior.
o getLeftInset()
Gets the left inset.
o getRightInset()
Gets the right inset.
o getTopInset()
Gets the top inset.
o getView(int)
Gets the n-th view in this container.
o getViewAtPoint(int, int, Rectangle)
Fetches the child view at the given point.
o getViewAtPosition(int, Rectangle)
Fetches the child view that represents the given position in the model.
o getViewCount()
Returns the number of views in this view.
o insert(int, View)
Inserts a single child view.
o isAfter(int, int, Rectangle)
Tests whether a point lies after the rectangle range.
o isBefore(int, int, Rectangle)
Tests whether a point lies before the rectangle range.
o loadChildren(ViewFactory)
Loads all of the children to initialize the view.
o modelToView(int, Shape)
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
o removeAll()
Removes all of the children.
o replace(int, int, View[])
Invalidates the layout and resizes the cache of requests/allocations, allowing for the replacement of child views.
o setInsets(short, short, short, short)
Sets the insets for the view.
o setParagraphInsets(AttributeSet)
Sets the insets from the paragraph attributes specified in the given attributes.
o setParent(View)
Sets the parent of the view.
o viewToModel(float, float, Shape)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Constructors

o CompositeView 
 public CompositeView(Element elem)
Constructs a CompositeView for the given element.

Parameters:
elem - the element this view is responsible for

Methods

o loadChildren 
 protected void loadChildren(ViewFactory f)
Loads all of the children to initialize the view. This is called by the setParent method. Subclasses can reimplement this to initialize their child views in a different manner. The default implementation creates a child view for each child element.

Parameters:
f - the view factory
o removeAll 
 public void removeAll()
Removes all of the children.

o insert 
 public void insert(int offs,
                    View v)
Inserts a single child view.

Parameters:
offs - the offset of the view to insert before >= 0
v - the view
o append 
 public void append(View v)
Appends a single child view.

Parameters:
v - the view
o replace 
 public void replace(int offset,
                     int length,
                     View views[])
Invalidates the layout and resizes the cache of requests/allocations, allowing for the replacement of child views.

Parameters:
offset - the starting offset into the child views to insert before >= 0
length - the number of existing child views affected >= 0
views - the child views to use as replacements
o setParent 
 public void setParent(View parent)
Sets the parent of the view. This is reimplemented to provide the superclass behavior as well as calling the loadChildren method. The children should not be loaded in the constructor because the act of setting the parent may cause them to try to search up the hierarchy (to get the hosting Container for example).

Parameters:
parent - the parent of the view, null if none
Overrides:
setParent in class View
o getViewCount 
 public int getViewCount()
Returns the number of views in this view.

Returns:
the number of views >= 0
Overrides:
getViewCount in class View
See Also:
getView
o getView 
 public View getView(int n)
Gets the n-th view in this container.

Parameters:
n - the number of the view to get, >= 0 && < getViewCount()
Returns:
the view
Overrides:
getView in class View
o getChildAllocation 
 public Shape getChildAllocation(int index,
                                 Shape a)
Fetches the allocation for the given child view. This enables finding out where various views are located, without assuming the views store their location.

Parameters:
index - the index of the child, >= 0 && < getViewCount()
a - the allocation to this view.
Returns:
the allocation to the child
Overrides:
getChildAllocation in class View
o modelToView 
 public Shape modelToView(int pos,
                          Shape a) throws BadLocationException
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

Parameters:
pos - the position to convert >= 0
a - the allocated region to render into
Returns:
the bounding box of the given position
Throws: BadLocationException
if the given position does not represent a valid location in the associated document
Overrides:
modelToView in class View
See Also:
modelToView
o viewToModel 
 public int viewToModel(float x,
                        float y,
                        Shape a)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters:
x - x coordinate of the view location to convert >= 0
y - y coordinate of the view location to convert >= 0
a - the allocated region to render into
Returns:
the location within the model that best represents the given point in the view >= 0
Overrides:
viewToModel in class View
See Also:
viewToModel
o isBefore 
 protected abstract boolean isBefore(int x,
                                     int y,
                                     Rectangle alloc)
Tests whether a point lies before the rectangle range.

Parameters:
x - the X coordinate >= 0
y - the Y coordinate >= 0
alloc - the rectangle
Returns:
true if the point is before the specified range
o isAfter 
 protected abstract boolean isAfter(int x,
                                    int y,
                                    Rectangle alloc)
Tests whether a point lies after the rectangle range.

Parameters:
x - the X coordinate >= 0
y - the Y coordinate >= 0
alloc - the rectangle
Returns:
true if the point is after the specified range
o getViewAtPoint 
 protected abstract View getViewAtPoint(int x,
                                        int y,
                                        Rectangle alloc)
Fetches the child view at the given point.

Parameters:
x - the X coordinate >= 0
y - the Y coordinate >= 0
alloc - the parent's allocation on entry, which should be changed to the child's allocation on exit
Returns:
the child view
o childAllocation 
 protected abstract void childAllocation(int index,
                                         Rectangle a)
Returns the allocation for a given child.

Parameters:
index - the index of the child, >= 0 && < getViewCount()
a - the allocation to the interior of the box on entry, and the allocation of the view containing the position on exit
o getViewAtPosition 
 protected View getViewAtPosition(int pos,
                                  Rectangle a)
Fetches the child view that represents the given position in the model. This is implemented to fetch the view in the case where there is a child view for each child element.

Parameters:
pos - the position >= 0
a - the allocation to the interior of the box on entry, and the allocation of the view containing the position on exit
Returns:
s the view representing the given position, or null if there isn't one
o getInsideAllocation 
 protected Rectangle getInsideAllocation(Shape a)
Translates the allocation given to the view to the allocation used for composing the interior. This takes into account any margins that were specified.

Parameters:
a - The allocation given to the view.
Returns:
s The allocation that represents the inside of the view after the margins have all been removed. If the given allocation was null, the return value is null.
o setParagraphInsets 
 protected final void setParagraphInsets(AttributeSet attr)
Sets the insets from the paragraph attributes specified in the given attributes.

Parameters:
attr - the attributes
o setInsets 
 protected final void setInsets(short top,
                                short left,
                                short bottom,
                                short right)
Sets the insets for the view.

Parameters:
top - the top inset >= 0
left - the left inset >= 0
bottom - the bottom inset >= 0
right - the right inset >= 0
o getLeftInset 
 protected final short getLeftInset()
Gets the left inset.

Returns:
the inset >= 0
o getRightInset 
 protected final short getRightInset()
Gets the right inset.

Returns:
the inset >= 0
o getTopInset 
 protected final short getTopInset()
Gets the top inset.

Returns:
the inset >= 0
o getBottomInset 
 protected final short getBottomInset()
Gets the bottom inset.

Returns:
the inset >= 0 
All Packages  Class Hierarchy  This Package  Previous  Next  Index